<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

<html lang="en">
<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Fri, 23 Jul 2010 20:16:21 +0000">

<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">

<title>HR_api (Hosting Reborn API PHP Library)</title>

</head>
<body id="definition" onload="parent.document.title=document.title;">

<div class="header">
<h1>Hosting Reborn API PHP Library</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../com/hostingreborn/api/package-summary.html">Package</a></li>
<li class="active">Class</li>
<li><a href="../../../com/hostingreborn/api/package-tree.html">Tree</a></li>
<li><a href="../../../overview-files.html">Files</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../com/hostingreborn/api/hr_api.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>

<div class="qualifiedName">com\hostingreborn\api\HR_api</div>
<a href="../../../source/hr_api.class.php.html#line33" class="location">HR_api.class.php at line 33</a>

<h1>Class HR_api</h1>

<pre class="tree"><strong>HR_api</strong><br /></pre>

<hr>

<p class="signature">public abstract  class <strong>HR_api</strong></p>

<div class="comment" id="overview_description"><p>ABSTRACT core interface to the Hosting Reborn API functions.

<p>For interfaces to API methods see:</p>
<ul>
<li><a href="HR_accountapi.html">HR_accountApi</a></ll>
<li><a href="HR_hostingaccountapi.html">HR_hostingaccountApi</a></ll>
<li><a href="HR_notificationapi.html">HR_notificationApi</a></ll>
<li><a href="HR_priceapi.html">HR_priceApi</a></ll>
<li><a href="HR_serverapi.html">HR_serverApi</a></ll>
<li><a href="HR_transactionapi.html">HR_transactionApi</a></ll>
</ul></p></div>

<dl>
<dt>See Also:</dt>
<dd><code>https//api.hostingreborn.com/docs/functions/</code></dd>
<dt>Author:</dt>
<dd>Jon Cram <jon@hostingreborn.com></dd>
<dt>Copyright:</dt>
<dd>https://api.hostingreborn.com/code/copyright/</dd>
<dt>License:</dt>
<dd>https://api.hostingreborn.com/code/license/</dd>
<dt>Version:</dt>
<dd>1.0 $Date: 2010/07/04 22:51:02 $ $Revision: 2c423d307a13 $ /</dd>
</dl>
<hr>

<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#__construct()">__construct</a>(string apiDomain, bool apiDomainIsSecure)</p><p class="description"></p></td>
</tr>
<tr>
<td class="type">protected  void</td>
<td class="description"><p class="name"><a href="#buildArguments()">buildArguments</a>(mixed standardArguments, mixed fullArgumentList, mixed additionalArguments)</p></td>
</tr>
<tr>
<td class="type">protected  void</td>
<td class="description"><p class="name"><a href="#buildQueryString()">buildQueryString</a>(mixed standardArguments, mixed fullArgumentList, mixed additionalArguments)</p></td>
</tr>
<tr>
<td class="type">protected  <a href="../../../com/hostingreborn/api/hr_apiresponse.html">HR_apiResponse</a></td>
<td class="description"><p class="name"><a href="#read()">read</a>(string request)</p><p class="description">Read data from the API (a GET request)</p></td>
</tr>
<tr>
<td class="type">protected  <a href="../../../com/hostingreborn/api/hr_apiresponse.html">HR_apiResponse</a></td>
<td class="description"><p class="name"><a href="#write()">write</a>(string request, array arguments)</p><p class="description">Write data to the API (a POST request)</p></td>
</tr>
</table>

<h2 id="detail_method">Method Detail</h2>
<a href="../../../source/hr_api.class.php.html#line53" class="location">HR_api.class.php at line 53</a>

<h3 id="__construct()">__construct</h3>
<code class="signature">public  void <strong>__construct</strong>(string apiDomain, bool apiDomainIsSecure)</code>
<div class="details">
<p></p><dl>
<dt>Parameters:</dt>
<dd>apiDomain - Optional, the API domain name.</dd>
<dd>apiDomainIsSecure - Optional, whether the API offers secure connections</dd>
</dl>
</div>

<hr>

<a href="../../../source/hr_api.class.php.html#line137" class="location">HR_api.class.php at line 137</a>

<h3 id="buildArguments()">buildArguments</h3>
<code class="signature">protected  void <strong>buildArguments</strong>(mixed standardArguments, mixed fullArgumentList, mixed additionalArguments)</code>
<div class="details">
</div>

<hr>

<a href="../../../source/hr_api.class.php.html#line142" class="location">HR_api.class.php at line 142</a>

<h3 id="buildQueryString()">buildQueryString</h3>
<code class="signature">protected  void <strong>buildQueryString</strong>(mixed standardArguments, mixed fullArgumentList, mixed additionalArguments)</code>
<div class="details">
</div>

<hr>

<a href="../../../source/hr_api.class.php.html#line74" class="location">HR_api.class.php at line 74</a>

<h3 id="read()">read</h3>
<code class="signature">protected  <a href="../../../com/hostingreborn/api/hr_apiresponse.html">HR_apiResponse</a> <strong>read</strong>(string request)</code>
<div class="details">
<p>Read data from the API (a GET request)</p><dl>
<dt>Parameters:</dt>
<dd>request - The URL to read from.</dd>
</dl>
</div>

<hr>

<a href="../../../source/hr_api.class.php.html#line86" class="location">HR_api.class.php at line 86</a>

<h3 id="write()">write</h3>
<code class="signature">protected  <a href="../../../com/hostingreborn/api/hr_apiresponse.html">HR_apiResponse</a> <strong>write</strong>(string request, array arguments)</code>
<div class="details">
<p>Write data to the API (a POST request)</p><dl>
<dt>Parameters:</dt>
<dd>request - The URL to write to</dd>
<dd>arguments - An array of key:value POST arguments</dd>
</dl>
</div>

<hr>

<div class="header">
<h1>Hosting Reborn API PHP Library</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../com/hostingreborn/api/package-summary.html">Package</a></li>
<li class="active">Class</li>
<li><a href="../../../com/hostingreborn/api/package-tree.html">Tree</a></li>
<li><a href="../../../overview-files.html">Files</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../com/hostingreborn/api/hr_api.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>

<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>

</body>

</html>